Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Refactor the repo/remote handling #1808

Merged
merged 3 commits into from
Jul 18, 2022
Merged

Refactor the repo/remote handling #1808

merged 3 commits into from
Jul 18, 2022

Conversation

mortenpi
Copy link
Member

This factors out the refactoring part of #1254 to make the whole thing a little more manageable. In short, it introduces the Remotes module which allows for a more flexible way to define the remote repository. The Remote objects can be passed via the repo keyword to makedocs:

makedocs(repo = Remotes.GitHub("JuliaDocs", "Documenter.jl"), ...)

The user can also define a custom Remotes.Remote type and overload the Remotes.repourl and Remotes.fileurl functions to control the link generation.

We do quite a bit of special handling of GitLab, BitBucket and Azure Devops repositories, so it would probably be worth adding special Remotes.Remote types for each of those too.

@mortenpi mortenpi mentioned this pull request May 24, 2022
Merged
@mortenpi mortenpi mentioned this pull request Jul 14, 2022
Merged
@mortenpi mortenpi force-pushed the mp/link-api branch 3 times, most recently from 1c61b32 to 333f683 Compare July 18, 2022 07:55
@mortenpi
Copy link
Member Author

I think this in a mergeable shape now. I reduced it down to the bare minimum to introduce the Remotes module, without changing any behavior as far as I can tell (except one case, where I replaced one buggy behavior with another).

I do have a bunch of follow-up ideas, to properly fix up getremote etc., which will likely change some behaviors and also refactor parts of the code. And then there is the UI change in #1254. But to make it manageable to review and to make sure I am not accidentally changing or breaking anything I did not intend, I want to merge this minimal version first and do those things in follow-up PR(s).

@fredrikekre Would you have time to look through this? It's a little big, but I would love to get another set of eyes on this.

@mortenpi
Copy link
Member Author

Thanks @fredrikekre!

@mortenpi mortenpi merged commit bafb88a into master Jul 18, 2022
@mortenpi mortenpi deleted the mp/link-api branch July 18, 2022 21:49
This was referenced Jul 19, 2022
Merged
Merged
@mortenpi mortenpi mentioned this pull request Sep 21, 2022
Closed
@mortenpi mortenpi mentioned this pull request Oct 8, 2022
Merged
@mortenpi mortenpi mentioned this pull request Oct 30, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fredrikekre fredrikekre fredrikekre approved these changes

Assignees
No one assigned
Labels
Type: Enhancement
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@mortenpi @fredrikekre